Schema

Retrieve Schema

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Retrieve Schema

curljavaandroidobjcjavascriptcsharpphpperlpython

curl -X GET\
"https://api.omise.co/schema?version=&private="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchemaApi;

import java.io.File;
import java.util.*;

public class SchemaApiExample {

    public static void main(String[] args) {
        
        SchemaApi apiInstance = new SchemaApi();
        String version = version_example; // String | 
        Boolean private = true; // Boolean | 
        try {
            apiInstance.schemaGet(version, private);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaApi#schemaGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.SchemaApi;

public class SchemaApiExample {

    public static void main(String[] args) {
        SchemaApi apiInstance = new SchemaApi();
        String version = version_example; // String | 
        Boolean private = true; // Boolean | 
        try {
            apiInstance.schemaGet(version, private);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaApi#schemaGet");
            e.printStackTrace();
        }
    }
}

String *version = version_example; //  (optional) (default to 2019-05-29)
Boolean *private = true; //  (optional) (default to false)

SchemaApi *apiInstance = [[SchemaApi alloc] init];

[apiInstance schemaGetWith:version
    private:private
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OmiseApi = require('omise_api');

var api = new OmiseApi.SchemaApi()
var opts = { 
  'version': version_example, // {{String}} 
  'private': true // {{Boolean}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.schemaGet(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class schemaGetExample
    {
        public void main()
        {

            var apiInstance = new SchemaApi();
            var version = version_example;  // String |  (optional)  (default to 2019-05-29)
            var private = true;  // Boolean |  (optional)  (default to false)

            try
            {
                apiInstance.schemaGet(version, private);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchemaApi.schemaGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSchemaApi();
$version = version_example; // String | 
$private = true; // Boolean | 

try {
    $api_instance->schemaGet($version, $private);
} catch (Exception $e) {
    echo 'Exception when calling SchemaApi->schemaGet: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchemaApi;

my $api_instance = WWW::SwaggerClient::SchemaApi->new();
my $version = version_example; # String | 
my $private = true; # Boolean | 

eval { 
    $api_instance->schemaGet(version => $version, private => $private);
};
if ($@) {
    warn "Exception when calling SchemaApi->schemaGet: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SchemaApi()
version = version_example # String |  (optional) (default to 2019-05-29)
private = true # Boolean |  (optional) (default to false)

try: 
    api_instance.schema_get(version=version, private=private)
except ApiException as e:
    print("Exception when calling SchemaApi->schemaGet: %s\n" % e)

Parameters

Name	Description
version	String
private	Boolean